import { Meta, Status, Props, Story } from '../../../../.storybook/components';
import * as Stories from './Toggle.stories';

<Meta of={Stories} />

# Toggle

<Status variant="stable" />

The toggle is a switcher between two mutually exclusive states: on and off.

<Story of={Stories.WithDescription} />
<Props />

## When to use it

When the user needs to make a selection (turn on or off a setting) that will immediately happen, without having the confirm the action.

## Usage guidelines

- **Do** always provide a default option for our user (when in doubt, leave it off)
- **Do** use the `description` prop to be even more detailed about what the toggle is about
- **Do not** use a toggle when the effect from the change does not take effect immediately

## Content guidelines

- **Do** always be clear and precise in what the toggle turns on and off
- **Do not** frame the label as a question
